/*
 * Copyright:  2018 smarabbit studio.
 *
 *  Licensed under the Confluent Community License; you may not use this file
 *  except in compliance with the License.  You may obtain a copy of the License at
 *
 *  http://www.confluent.io/confluent-community-license
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 *  WARRANTIES OF ANY KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations under the License.
 *
 *  @作   者： 黄开晖 (117227773@qq.com)
 *  @日   期:  2020年9月3日
 */
package com.tank.game.api.config;

import cn.hutool.core.util.StrUtil;

import java.util.*;

/**
 * {@link Parameters}, 初始化参数
 *
 * @author Zed
 */
public interface Parameters {

    static final String DOT = ".";

    /**
     * 根据<code>name</code>获取参数值
     *
     * @param name {@link String}, 参数名
     * @return {@link String}, 参数值，参数不存在则返回null.
     */
    String getParameter(String name);

    /**
     * 转化成一个新的Map
     *
     * @return {@link Map}
     */
    default Map<String, String> asMap() {
        Map<String, String> map = new HashMap<>();
        for (String parameterName : this.getParameterNames()) {
            map.put(parameterName, this.getParameter(parameterName));
        }
        return map;
    }

    /**
     * 转化为key 和 value 非空的属性
     *
     * @return {@link Properties}
     */
    default Properties asAllNotNullProperties() {
        Properties properties = new Properties();
        for (String key : this.getParameterNames()) {
            String value = this.getParameter(key);
            if (StrUtil.isNotBlank(value)) {
                properties.setProperty(key, value);
            }
        }
        return properties;
    }

    /**
     * 根据<code>name</code>获取参数值,如果参数不存在，则返回<code>defaultValue</code>
     *
     * @param name         {@link String}, 参数名
     * @param defaultValue {@link String}, 参数不存在时返回的缺省值
     * @return {@link String}, 参数不存在是，返回<code>defautlValue</code>
     */
    default String getParameter(String name, String defaultValue) {
        String result = this.getParameter(name);
        return result == null ? defaultValue : result;
    }

    /**
     * 获取所有初始化参数名称
     *
     * @return {@link List}, 列表
     */
    List<String> getParameterNames();

    /**
     * 获取所有满足<code>prefix</code>前缀的参数名<br>
     * 如果<code>name</code>不是以"."为结尾，执行时会自动添加"."后再进行比较。
     *
     * @param prefix {@link String}
     * @return {@link List}
     */
    List<String> getParameterNames(String prefix);

    /**
     * 获取所有<code>prefix</code>前缀的参数构成子初始化参数
     *
     * <pre>
     * </pre>
     *
     * @param prefix {@link String}, 前缀
     * @return {@link Parameters}
     */
    default Parameters subset(String prefix) {
        Objects.requireNonNull(prefix, "\"prefix\" cannot be null.");
        return new SubsetParameters(this, prefix);
    }

}
